# Copyright (C) 1999--2002  Joel Rosdahl
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA
#
# keltus <keltus@users.sourceforge.net>

"""irclib -- Internet Relay Chat (IRC) protocol client library.

This library is intended to encapsulate the IRC protocol at a quite
low level.  It provides an event-driven IRC client framework.  It has
a fairly thorough support for the basic IRC protocol, CTCP, DCC chat,
but DCC file transfers is not yet supported.

In order to understand how to make an IRC client, I'm afraid you more
or less must understand the IRC specifications.  They are available
here: [IRC specifications].

The main features of the IRC client framework are:

  * Abstraction of the IRC protocol.
  * Handles multiple simultaneous IRC server connections.
  * Handles server PONGing transparently.
  * Messages to the IRC server are done by calling methods on an IRC
	connection object.
  * Messages from an IRC server triggers events, which can be caught
	by event handlers.
  * Reading from and writing to IRC server sockets are normally done
	by an internal select() loop, but the select()ing may be done by
	an external main loop.
  * Functions can be registered to execute at specified times by the
	event-loop.
  * Decodes CTCP tagging correctly (hopefully); I haven't seen any
	other IRC client implementation that handles the CTCP
	specification subtilties.
  * A kind of simple, single-server, object-oriented IRC client class
	that dispatches events to instance methods is included.

Current limitations:

  * The IRC protocol shines through the abstraction a bit too much.
  * Data is not written asynchronously to the server, i.e. the write()
	may block if the TCP buffers are stuffed.
  * There are no support for DCC file transfers.
  * The author haven't even read RFC 2810, 2811, 2812 and 2813.
  * Like most projects, documentation is lacking...

.. [IRC specifications] http://www.irchelp.org/irchelp/rfc/
"""

import bisect
import re
import select
import socket
import string
import sys
import time
try:
	from collections import UserDict
except ImportError:
	from UserDict import UserDict

VERSION = 0, 4, 8, 0
DEBUG = 0

# TODO
# ----
# (maybe) thread safety
# (maybe) color parser convenience functions
# documentation (including all event types)
# (maybe) add awareness of different types of ircds
# send data asynchronously to the server (and DCC connections)
# (maybe) automatically close unused, passive DCC connections after a while

# NOTES
# -----
# connection.quit() only sends QUIT to the server.
# ERROR from the server triggers the error event and the disconnect event.
# dropping of the connection triggers the disconnect event.

## Exceptions ##

class IRCError(Exception):
	"""Represents a generic IRC exception."""

class DCCConnectionError(IRCError):
	"""Represents an error while creating a DCC connection."""

## Classes ##

class IRC(object):
	"""Class that handles one or several IRC server connections.
	
	When an IRC object has been instantiated, it can be used to create
	Connection objects that represent the IRC connections.  The
	responsibility of the IRC object is to provide an event-driven
	framework for the connections and to keep the connections alive.
	It runs a select loop to poll each connection's TCP socket and
	hands over the sockets with incoming data for processing by the
	corresponding connection.
	
	The methods of most interest for an IRC client writer are server,
	add_global_handler, remove_global_handler, execute_at,
	execute_delayed, process_once and process_forever.
	
	Here is an example:
	
		irc = irclib.IRC()
		server = irc.server()
		server.connect(\"irc.some.where\", 6667, \"my_nickname\")
		server.privmsg(\"a_nickname\", \"Hi there!\")
		irc.process_forever()
	
	This will connect to the IRC server irc.some.where on port 6667
	using the nickname my_nickname and send the message \"Hi there!\"
	to the nickname a_nickname.
	"""
	
	def __init__(self, fn_to_add_socket=None, fn_to_remove_socket=None, fn_to_add_timeout=None):
		"""Constructor for IRC objects.
		
		Optional arguments are fn_to_add_socket, fn_to_remove_socket
		and fn_to_add_timeout.  The first two specify functions that
		will be called with a socket object as argument when the IRC
		object wants to be notified (or stop being notified) of data
		coming on a new socket.  When new data arrives, the method
		process_data should be called.  Similarly, fn_to_add_timeout
		is called with a number of seconds (a floating point number)
		as first argument when the IRC object wants to receive a
		notification (by calling the process_timeout method).  So, if
		e.g. the argument is 42.17, the object wants the
		process_timeout method to be called after 42 seconds and 170
		milliseconds.
		
		The three arguments mainly exist to be able to use an external
		main loop (for example Tkinter's or PyGTK's main app loop)
		instead of calling the process_forever method.
		
		An alternative is to just call ServerConnection.process_once()
		once in a while."""
		
		if fn_to_add_socket and fn_to_remove_socket:
			self.fn_to_add_socket = fn_to_add_socket
			self.fn_to_remove_socket = fn_to_remove_socket
		else:
			self.fn_to_add_socket = None
			self.fn_to_remove_socket = None
		
		self.fn_to_add_timeout = fn_to_add_timeout
		self.connections = []
		self.handlers = {}
		# List of tuples in the format (time, function, arguments)
		self.delayed_commands = []
		
		self.add_global_handler("ping", _ping_ponger, -42)
	
	def server(self):
		"""Creates and returns a `ServerConnection` object."""
		
		c = ServerConnection(self)
		self.connections.append(c)
		return(c)
	
	def process_data(self, sockets):
		"""Given a list of socket objects, reads additional data if they are a
		socket used by a connection.
		
		See documentation for `IRC.__init__`."""
		
		for s in sockets:
			for c in self.connections:
				if s == c._get_socket():
					c.process_data()
	
	def process_timeout(self):
		"""Processes a timeout notification.
		
		See documentation for `IRC.__init__`."""
		
		t = time.time()
		while self.delayed_commands:
			if t >= self.delayed_commands[0][0]:
				self.delayed_commands[0][1](*self.delayed_commands[0][2])
				del self.delayed_commands[0]
			else:
				break
	
	def process_once(self, timeout=0):
		"""Processes data from connections once.
		The timeout parameter defines the number of seconds the select() should
		wait if no data is available.
		
		This method should be called periodically to check and process
		incoming data, if there are any. If that seems boring, look
		at the process_forever method."""
		
		sockets = map(lambda x: x._get_socket(), self.connections)
		sockets = filter(lambda x: x != None, sockets)
		if sockets:
			(i, o, e) = select.select(sockets, [], [], timeout)
			self.process_data(i)
		else:
			time.sleep(timeout)
		self.process_timeout()
	
	def process_forever(self, timeout=0.2):
		"""Runs an infinite loop, processing data from connections.
		
		This method repeatedly calls process_once with the timeout parameter."""
		
		while(True):
			self.process_once(timeout)
	
	def disconnect_all(self, message=""):
		"""Disconnects all connections."""
		
		for c in self.connections:
			c.disconnect(message)
	
	def add_global_handler(self, event, handler, priority=0):
		"""Adds a global handler function for a specific event type.
		
		The following parameters are expected:
		 - event: Event type (a string). See the numeric_events dictionary in
		   irclib.py for possible event types.
		 - handler: A callback function.
		 - priority: A number. The lower the number, the higher the priority of
		   the function will be above other handlers of the event. Default 0.
		
		The handler function is called whenever the specified event is triggered
		in any of the connections. See documentation for the Event class.
		
		The handler functions are called in priority order (lowest number is
		highest priority). If a handler function returns 'NO MORE', no more
		handlers will be called."""
		
		if not event in self.handlers:
			self.handlers[event] = []
		bisect.insort(self.handlers[event], ((priority, handler)))
	
	def remove_global_handler(self, event, handler):
		"""Removes a global handler function from an event.
		
		Returns a boolean vaue indcating success."""
		
		if not event in self.handlers:
			return(False)
		
		for h in self.handlers[event]:
			if handler == h[1]:
				self.handlers[event].remove(h)
		
		return(True)
	
	def execute_at(self, at, function, arguments=()):
		"""Executes a function at a specified time.
		
		See `execute_delayed`."""
		
		self.execute_delayed(at-time.time(), function, arguments)
	
	def execute_delayed(self, delay, function, arguments=()):
		"""Execute a function after a specified time.
		
		Arguments:
		 - at: Execute at this time (standard time_t UNIX epoch time).
		 - function: Function to call.
		 - arguments: Arguments to pass to the function."""
		
		bisect.insort(self.delayed_commands, (delay+time.time(), function, arguments))
		if self.fn_to_add_timeout:
			self.fn_to_add_timeout(delay)
	
	def dcc(self, dcctype="chat"):
		"""Creates and returns a DCCConnection object
		The `dcctype` parameter should be "chat" for DCC CHAT connections or
		"raw" for DCC SEND (or other DCC types). If "chat", incoming data will
		be split in newline-separated chunks. If "raw", incoming data is left
		untouched."""
		
		c = DCCConnection(self, dcctype)
		self.connections.append(c)
		return(c)
	
	def _handle_event(self, connection, event):
		h = self.handlers
		for handler in h.get("all_events", []) + h.get(event.eventtype(), []):
			if handler[1](connection, event) == "NO MORE":
				return
	
	def _remove_connection(self, connection):
		self.connections.remove(connection)
		if self.fn_to_remove_socket:
			self.fn_to_remove_socket(connection._get_socket())

_rfc_1459_command_regexp = re.compile("^(:(?P<prefix>[^ ]+) +)?(?P<command>[^ ]+)( *(?P<argument> .+))?")

class Connection(object):
	"""Base class for IRC connections.
	
	Must be overridden."""
	
	def __init__(self, irclibobj):
		self.irclibobj = irclibobj
	
	def _get_socket():
		raise(IRCError("Not overridden"))
	
	## Convenience wrappers ##
	
	def execute_at(self, at, function, arguments=()):
		self.irclibobj.execute_at(at, function, arguments)
	
	def execute_delayed(self, delay, function, arguments=()):
		self.irclibobj.execute_delayed(delay, function, arguments)

class ServerConnectionError(IRCError):
	"""Represents a generic connection error.""" 

class ServerNotConnectedError(ServerConnectionError):
	"""Represents a server-side connection failure."""

# EFNet doesn't follow the RFC: their ircd seems to use \n as message separator.
# TODO: Move this elsewhere
_linesep_regexp = re.compile("\r?\n")

class ServerConnection(Connection):
	"""Represents an IRC server connection.
	
	ServerConnection objects are instantiated by calling the server
	method on an IRC object."""
	
	def __init__(self, irclibobj):
		Connection.__init__(self, irclibobj)
		self.connected = 0  # Not connected yet.
		self.socket = None
		self.ssl = None
	
	def connect(self, server, port, nickname, password=None, username=None, ircname=None, localaddress="", localport=0, ssl=False, ipv6=False):
		"""Connects/reconnects to a server.
		
		Arguments:
		 - server: Server name.
		 - port: Port number.
		 - nickname: The nickname.
		 - password: Connection password (if any).
		 - username: The username.
		 - ircname: The IRC name ("realname").
		 - localaddress: A specific local IP address to bind the connection to.
		 - localport: A specific local port to bind the connection to.
		 - ssl: Enable support for SSL encryption.
		 - ipv6: Enable support for IPv6 transfer.
		
		This function can be used to reconnect a closed connection, or change
		an open connection to using other arguments
		
		Returns the ServerConnection object."""
		
		if self.connected:
			self.disconnect("Changing servers")
		
		self.previous_buffer = ""
		self.handlers = {}
		self._real_server_name = ""
		self._real_nickname = nickname
		self.server = server
		self.port = port
		self.nickname = nickname
		self.username = username or nickname
		self.ircname = ircname or nickname
		self.password = password
		self.localaddress = localaddress
		self.localport = localport
		self.localhost = socket.gethostname()
		self.charset = "iso-8859-1"
		
		if ipv6:
			self.socket = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
		else:
			self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
		
		try:
			self.socket.bind((self.localaddress, self.localport))
			self.socket.connect((self.server, self.port))
			if ssl:
				self.ssl = socket.ssl(self.socket)
		except socket.error as x:
			self.socket.close()
			self.socket = None
			raise(ServerConnectionError("Couldn't connect to socket: %s" % x))
		
		self.connected = 1
		if self.irclibobj.fn_to_add_socket:
			self.irclibobj.fn_to_add_socket(self.socket)
		
		# Log on...
		if self.password:
			self.pass_(self.password)
		self.nick(self.nickname)
		self.user(self.username, self.ircname)
		return(self)
	
	def close(self):
		"""Close the connection.
		
		This method closes the connection permanently; after it has
		been called, the object is unusable."""
		
		self.disconnect("Closing object")
		self.irclibobj._remove_connection(self)
	
	def _get_socket(self):
		return(self.socket)
	
	@property
	def server_name(self):
		"""Gets the (real) server name.
		
		This method returns the (real) server name, or, more specifically, what
		the server calls itself."""
		
		if self._real_server_name:
			return(self._real_server_name)
		else:
			return("")
	
	@property
	def real_nickname(self):
		"""Gets the (real) nick name of the connected user.
		
		This method returns the (real) nickname. The library keeps track of
		nick changes, so it might not be the nick name that was initially passed
		to the connect() method."""
		
		return(self._real_nickname)
	
	def process_data(self):
		"""Processes information received from the server socket, and runs
		events based on the data."""
		
		# TODO merge client stuff into here
		try:
			if self.ssl:
				new_data = self.ssl.read(2**14)
			else:
				new_data = self.socket.recv(2**14)
		except socket.error:
			# The server hung up.
			self.disconnect("Connection reset by peer")
			return
		if not new_data:
			# Read nothing: connection must be down.
			self.disconnect("Connection reset by peer")
			return
		
		lines = _linesep_regexp.split(self.previous_buffer + new_data.decode(self.charset))
		
		# Save the last, unfinished line.
		self.previous_buffer = lines.pop()
		
		for line in lines:
			if DEBUG:
				print("FROM SERVER:", line)
			
			if not line:
				continue
			
			prefix = None
			command = None
			arguments = None
			self._handle_event(Event("all_raw_messages", self.get_server_name(), None, [line]))
			
			m = _rfc_1459_command_regexp.match(line)
			if m.group("prefix"):
				prefix = m.group("prefix")
				if not self.real_server_name:
					self.real_server_name = prefix
				else:
					prefix = IRCUser(self, mask=prefix)
			
			if m.group("command"):
				command = m.group("command").lower()
			
			if m.group("argument"):
				a = m.group("argument").split(" :", 1)
				arguments = a[0].split()
				if len(a) == 2:
					arguments.append(a[1])
			
			# Translate numerics into more readable strings.
			if command in numeric_events:
				command = numeric_events[command]
			
			if command == "nick":
				if nm_to_n(prefix) == self.real_nickname:
					self.real_nickname = arguments[0]
			elif command == "welcome":
				# Record the nickname in case the client changed nick
				# in a nicknameinuse callback.
				self.real_nickname = arguments[0]
			
			if command in ["privmsg", "notice"]:
				target, message = arguments[0], arguments[1]
				messages = _ctcp_dequote(message)
				
				if command == "privmsg":
					if is_channel(target):
						command = "pubmsg"
				else:
					if is_channel(target):
						command = "pubnotice"
					else:
						command = "privnotice"
				
				for m in messages:
					if isinstance(m, tuple):
						if command in ["privmsg", "pubmsg"]:
							command = "ctcp"
						else:
							command = "ctcpreply"
						
						m = list(m)
						if DEBUG:
							print("command: %s, source: %s, target: %s, arguments: %s" % (command, prefix, target, m))
						self._handle_event(Event(command, prefix, target, m))
						if command == "ctcp" and m[0] == "ACTION":
							self._handle_event(Event("action", prefix, target, m[1:]))
					else:
						if DEBUG:
							print("command: %s, source: %s, target: %s, arguments: %s" % (command, prefix, target, [m]))
						self._handle_event(Event(command, prefix, target, [m]))
			else:
				target = None
				
				if command == "quit":
					arguments = [arguments[0]]
				elif command == "ping":
					target = arguments[0]
				else:
					target = arguments[0]
					arguments = arguments[1:]
				
				if command == "mode":
					if not is_channel(target):
						command = "umode"
				
				if DEBUG:
					print("command: %s, source: %s, target: %s, arguments: %s" % (command, prefix, target, arguments))
				self._handle_event(Event(command, prefix, target, arguments))
	
	def _handle_event(self, event):
		"""[Internal]"""
		self.irclibobj._handle_event(self, event)
		if event.eventtype() in self.handlers:
			for fn in self.handlers[event.eventtype()]:
				fn(self, event)
	
	def is_connected(self):
		"""Returns the connection status.
		
		Returns true if connected, otherwise false."""
		
		return(self.connected)
	
	def add_global_handler(self, *args):
		"""Adds a global handler.
		
		See documentation for IRC.add_global_handler."""
		
		self.irclibobj.add_global_handler(*args)
	
	def remove_global_handler(self, *args):
		"""Removes a global handler.
		
		See documentation for IRC.remove_global_handler."""
		
		self.irclibobj.remove_global_handler(*args)
	
	def action(self, target, action):
		"""Sends a CTCP ACTION command."""
		
		self.ctcp("ACTION", target, action)
	
	def admin(self, server=""):
		"""Sends an ADMIN command."""
		
		self.send_raw(" ".join(["ADMIN", server]).strip())
	
	def ctcp(self, ctcptype, target, parameter=""):
		"""Sends a CTCP command."""
		
		ctcptype = ctcptype.upper()
		self.privmsg(target, "\001%s%s\001" % (ctcptype, parameter and (" " + parameter) or ""))
	
	def ctcp_reply(self, target, parameter):
		"""Sends a CTCP REPLY command."""
		
		self.notice(target, "\001%s\001" % parameter)
	
	def disconnect(self, message=""):
		"""Hangs up the connection, optionally with a quit message."""
		
		if not self.connected:
			return
		
		self.connected = 0
		
		self.quit(message)
		
		try:
			self.socket.close()
		except socket.error:
			pass
		
		self.socket = None
		self._handle_event(Event("disconnect", self.server, "", [message]))
	
	def globops(self, text):
		"""Sends a GLOBOPS command."""
		
		self.send_raw("GLOBOPS :" + text)
	
	def info(self, server=""):
		"""Sends an INFO command."""
		
		self.send_raw(" ".join(["INFO", server]).strip())
	
	def invite(self, nick, channel):
		"""Sends an INVITE command."""
		
		self.send_raw(" ".join(["INVITE", nick, channel]).strip())
	
	def ison(self, nicks):
		"""Sends an ISON command for a list of nicks."""
		
		self.send_raw("ISON " + " ".join(nicks))
	
	def join(self, channel, key=""):
		"""Sends a JOIN command."""
		
		self.send_raw("JOIN %s%s" % (channel, (key and (" " + key))))
	
	def kick(self, channel, nick, comment=""):
		"""Sends a KICK command."""
		
		self.send_raw("KICK %s %s%s" % (channel, nick, (comment and (" :" + comment))))
	
	def links(self, remote_server="", server_mask=""):
		"""Sends a LINKS command."""
		
		command = "LINKS"
		if remote_server:
			command = command + " " + remote_server
		if server_mask:
			command = command + " " + server_mask
		self.send_raw(command)
	
	def list(self, channels=None, server=""):
		"""Sends a LIST command."""
		
		command = "LIST"
		if channels:
			command = command + " " + ",".join(channels)
		if server:
			command = command + " " + server
		self.send_raw(command)
	
	def lusers(self, server=""):
		"""Sends a LUSERS command."""
		
		self.send_raw("LUSERS" + (server and (" " + server)))
	
	def mode(self, target, command):
		"""Sends a MODE command."""
		
		self.send_raw("MODE %s %s" % (target, command))
	
	def motd(self, server=""):
		"""Sends an MOTD command."""
		
		self.send_raw("MOTD" + (server and (" " + server)))
	
	def names(self, channels=None):
		"""Sends a NAMES command."""
		
		self.send_raw("NAMES" + (channels and (" " + ",".join(channels)) or ""))
	
	def nick(self, newnick):
		"""Sends a NICK command."""
		
		self.send_raw("NICK " + newnick)
	
	def notice(self, target, text):
		"""Sends a NOTICE command."""
		
		# Should limit len(text) here! And/or split it across multiple messages
		self.send_raw("NOTICE %s :%s" % (target, text))
	
	def oper(self, nick, password):
		"""Sends an OPER command."""
		
		self.send_raw("OPER %s %s" % (nick, password))
	
	def part(self, channels, message=""):
		"""Sends a PART command."""
		
		if isinstance(channels, str):
			self.send_raw("PART " + channels + (message and (" " + message)))
		else:
			self.send_raw("PART " + ",".join(channels) + (message and (" " + message)))
	
	def pass_(self, password):
		"""Sends a PASS command."""
		
		self.send_raw("PASS " + password)
	
	def ping(self, target, target2=""):
		"""Sends a PING command."""
		
		self.send_raw("PING %s%s" % (target, target2 and (" " + target2)))
	
	def pong(self, target, target2=""):
		"""Sends a PONG command."""
		
		self.send_raw("PONG %s%s" % (target, target2 and (" " + target2)))
	
	def privmsg(self, target, text):
		"""Sends a PRIVMSG command."""
		
		# Should limit len(text) here! And/or split it across multiple messages
		self.send_raw("PRIVMSG %s :%s" % (target, text))
	
	def privmsg_many(self, targets, text):
		"""Sends a PRIVMSG command to a list of targets."""
		
		# Should limit len(text) here! And/or split it across multiple messages
		self.send_raw("PRIVMSG %s :%s" % (",".join(targets), text))
	
	def quit(self, message=""):
		"""Sends a QUIT command."""
		
		self.send_raw("QUIT" + (message and (" :" + message)))
	
	def send_raw(self, string):
		"""Sends a raw string to the server.
		
		The string will be padded with appropriate CR LF."""
		
		if self.socket is None:
			raise(ServerNotConnectedError("Not connected."))
		try:
			if self.ssl:
				self.ssl.write((string + "\r\n").encode(self.charset))
			else:
				self.socket.send((string + "\r\n").encode(self.charset))
			if DEBUG:
				print("TO SERVER:", string)
		except socket.error:
			# Ouch!
			self.disconnect("Connection reset by peer.")
	
	def squit(self, server, comment=""):
		"""Sends an SQUIT command."""
		
		self.send_raw("SQUIT %s%s" % (server, comment and (" :" + comment)))
	
	def stats(self, statstype, server=""):
		"""Sends a STATS command."""
		
		self.send_raw("STATS %s%s" % (statstype, server and (" " + server)))
	
	def time(self, server=""):
		"""Sends a TIME command."""
		
		self.send_raw("TIME" + (server and (" " + server)))
	
	def topic(self, channel, new_topic=None):
		"""Sends a TOPIC command."""
		
		if new_topic is None:
			self.send_raw("TOPIC " + channel)
		else:
			self.send_raw("TOPIC %s :%s" % (channel, new_topic))
	
	def trace(self, target=""):
		"""Sends a TRACE command."""
		
		self.send_raw("TRACE" + (target and (" " + target)))

	def user(self, username, realname):
		"""Sends a USER command."""
		
		self.send_raw("USER %s 0 * :%s" % (username, realname))
	
	def userhost(self, nicks):
		"""Sends a USERHOST command."""
		
		self.send_raw("USERHOST " + ",".join(nicks))
	
	def users(self, server=""):
		"""Sends a USERS command."""
		
		self.send_raw("USERS" + (server and (" " + server)))
	
	def version(self, server=""):
		"""Sends a VERSION command."""
		
		self.send_raw("VERSION" + (server and (" " + server)))
	
	def wallops(self, text):
		"""Sends a WALLOPS command."""
		
		self.send_raw("WALLOPS :" + text)
	
	def who(self, target="", op=False):
		"""Sends a WHO command."""
		
		self.send_raw("WHO%s%s" % (target and (" " + target), op and (" o")))
	
	def whois(self, targets):
		"""Sends a WHOIS command."""
		
		self.send_raw("WHOIS " + ",".join(targets))
	
	def whowas(self, nick, max="", server=""):
		"""Sends a WHOWAS command."""
		
		self.send_raw("WHOWAS %s%s%s" % (nick, max and (" " + max), server and (" " + server)))

class DCCConnection(Connection):
	"""Represents a DCC connection.
	
	DCCConnection objects are instantiated by calling the dcc
	method on an IRC object."""
	
	def __init__(self, irclibobj, dcctype):
		Connection.__init__(self, irclibobj)
		self.connected = 0
		self.passive = 0
		self.dcctype = dcctype
		self.peeraddress = None
		self.peerport = None
		self.charset = "iso-8859-1"
	
	def connect(self, address, port):
		"""Connects/reconnects to a DCC peer.
		
		Arguments:
		 - address: Host/IP address of the peer.
		 - port: The port number to connect to.
		
		Returns the `DCCConnection` object."""
		
		self.peeraddress = socket.gethostbyname(address)
		self.peerport = port
		self.socket = None
		self.previous_buffer = ""
		self.handlers = {}
		self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
		self.passive = 0
		try:
			self.socket.connect((self.peeraddress, self.peerport))
		except socket.error as x:
			raise(DCCConnectionError("Couldn't connect to socket: %s" % x))
		self.connected = 1
		if self.irclibobj.fn_to_add_socket:
			self.irclibobj.fn_to_add_socket(self.socket)
		return(self)
	
	def listen(self):
		"""Waits for a connection/reconnection from a DCC peer.
		
		Returns the `DCCConnection` object.
		
		The local IP address and port are available as self.localaddress and
		self.localport. After connection from a peer, the peer address and port
		are available as self.peeraddress and self.peerport."""
		
		self.previous_buffer = ""
		self.handlers = {}
		self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
		self.passive = 1
		try:
			self.socket.bind((socket.gethostbyname(socket.gethostname()), 0))
			self.localaddress, self.localport = self.socket.getsockname()
			self.socket.listen(10)
		except socket.error as x:
			raise(DCCConnectionError("Couldn't bind socket: %s" % x))
		
		return(self)
	
	def disconnect(self, message=""):
		"""Hangs up the connection and removes the object, optionally giving a
		quit message on disconnect."""
		
		if not self.connected:
			return
		
		self.connected = 0
		try:
			self.socket.close()
		except socket.error:
			pass
		self.socket = None
		self.irclibobj._handle_event(
			self,
			Event("dcc_disconnect", self.peeraddress, "", [message]))
		self.irclibobj._remove_connection(self)
	
	def process_data(self):
		"""Processes information received from the peer."""
		
		if self.passive and not self.connected:
			conn, (self.peeraddress, self.peerport) = self.socket.accept()
			self.socket.close()
			self.socket = conn
			self.connected = 1
			if DEBUG:
				print("DCC connection from %s:%d" % (self.peeraddress, self.peerport))
			self.irclibobj._handle_event(self, Event("dcc_connect", self.peeraddress, None, None))
			return
		
		try:
			new_data = self.socket.recv(2**14)
		except socket.error:
			# The server hung up.
			self.disconnect("Connection reset by peer")
			return
		if not new_data:
			# Read nothing: connection must be down.
			self.disconnect("Connection reset by peer")
			return
		
		if self.dcctype == "chat":
			# The specification says lines are terminated with LF, but
			# it seems safer to handle CR LF terminations too.
			chunks = _linesep_regexp.split(self.previous_buffer + new_data.decode(self.charset))
			
			# Save the last, unfinished line.
			self.previous_buffer = chunks[-1]
			if len(self.previous_buffer) > 2**14:
				# Bad peer! Naughty peer!
				self.disconnect()
				return
			chunks = chunks[:-1]
		else:
			chunks = [new_data]
		
		command = "dccmsg"
		prefix = self.peeraddress
		target = None
		for chunk in chunks:
			if DEBUG:
				print("FROM PEER:", chunk)
			arguments = [chunk]
			if DEBUG:
				print("command: %s, source: %s, target: %s, arguments: %s" % (command, prefix, target, arguments))
			self.irclibobj._handle_event(self, Event(command, prefix, target, arguments))
	
	def _get_socket(self):
		return(self.socket)
	
	def privmsg(self, string):
		"""Sends data to DCC peer.
		
		The string will be padded with appropriate LF if it's a DCC
		CHAT session."""
		
		try:
			if DEBUG:
				print("TO PEER: %s" % string)
			
			if self.dcctype == "chat":
				string += "\n"
			self.socket.send(string.encode(self.charset))
		except socket.error:
			# Ouch!
			self.disconnect("Connection reset by peer.")

class SimpleIRCClient(object):
	"""A simple single-server IRC client class.
	
	This is an example of an object-oriented wrapper of the IRC
	framework. A real IRC client can be made by subclassing this
	class and adding appropriate methods.
	
	The method on_join will be called when a "join" event is created
	(which is done when the server sends a JOIN messsage/command),
	on_privmsg will be called for "privmsg" events, and so on.  The
	handler methods get two arguments: the connection object (same as
	self.connection) and the event object.
	
	Instance attributes that can be used by subclasses:
	 - ircobj: The IRC instance.
	 - connection: The ServerConnection instance for this client.
	 - dcc_connections: A list of DCCConnection instances."""
	
	def __init__(self):
		self.ircobj = IRC()
		self.connection = self.ircobj.server()
		self.dcc_connections = []
		
		self.ircobj.add_global_handler("all_events", self._dispatcher, -10)
		self.ircobj.add_global_handler("dcc_disconnect", self._dcc_disconnect, -10)
	
	def _dispatcher(self, c, e):
		"""Dispactes an event to local handers."""
		
		# TODO: These handlers are always called first, which can be wrong.
		# They will not have updated data.
		m = "on_" + e.type
		if hasattr(self, m):
			getattr(self, m)(c, e)
	
	def _dcc_disconnect(self, c, e):
		self.dcc_connections.remove(c)
	
	def connect(self, server, port, nickname, password=None, username=None, ircname=None, localaddress="", localport=0, ssl=False, ipv6=False):
		"""Connects/reconnects to a server. See `ServerConnection.connect`."""
		
		self.connection.connect(server, port, nickname, password, username, ircname, localaddress, localport, ssl, ipv6)
	
	def dcc_connect(self, address, port, dcctype="chat"):
		"""Connects to a DCC peer, returning a new `DCCConnection` instance."""
		
		dcc = self.ircobj.dcc(dcctype)
		self.dcc_connections.append(dcc)
		dcc.connect(address, port)
		return(dcc)
	
	def dcc_listen(self, dcctype="chat"):
		"""Listens for connections from a DCC peer.
		
		Returns a DCCConnection instance."""
		
		dcc = self.ircobj.dcc(dcctype)
		self.dcc_connections.append(dcc)
		dcc.listen()
		return(dcc)
	
	def start(self):
		"""Starts the IRC client."""
		self.ircobj.process_forever()

class Event(object):
	"""Represents an IRC event."""
	
	def __init__(self, ttype, source, target, arguments=None):
		"""Constructor of Event objects.
		
		Arguments:
		 - type: A string describing the event.
		 - source: The originator of the event (a nick mask or a server)
		 - target: The target of the event (a nick or a channel).
		 - arguments: A list of event specific arguments.
		
		The arguments are available as properties of the object."""
		
		self._type = type
		self._source = source
		self._target = target
		if arguments:
			self._arguments = arguments
		else:
			self._arguments = []
	
	@property
	def type(self):
		return(self._type)
	
	@property
	def source(self):
		return(self._source)
	
	@property
	def target(self):
		return(self._target)
	
	@property
	def arguments(self):
		return(self._arguments)

class IRCDict(UserDict):
	"""A dictionary suitable for storing an IRC-related hashtable.
	
	Dictionary keys a and b are considered equal if and only if
	irc_lower(a) == irc_lower(b)
	
	Otherwise, it should behave exactly as a normal dictionary."""
	
	def __init__(self, dict=None, **kwargs):
		UserDict.__init__(self, dict=dict, **kwargs)
		# Canonical keys
		self.canon_keys = {}
		if dict is not None:
			self.update(dict)
	
	def __cmp__(self, dict):
		if isinstance(dict, IRCDict):
			return(cmp(self.data, dict.data))
		else:
			return(cmp(self.data, dict))
	
	def __getitem__(self, key):
		return(self.data[self.canon_keys[irc_lower(key)]])
	
	def __setitem__(self, key, item):
		self.data[key] = item
		self.canon_keys[irc_lower(key)] = key
	
	def __delitem__(self, key):
		ck = irc_lower(key)
		del self.data[self.canon_keys[ck]]
		del self.canon_keys[ck]
	
	def __iter__(self):
		return(iter(self.data))
	
	def __contains__(self, key):
		return(self.has_key(key))
	
	def clear(self):
		self.data.clear()
		self.canon_keys.clear()
	
	def keys(self):
		return(self.data.keys())
	
	def items(self):
		return(self.data.items())
	
	def values(self):
		return(self.data.values())
	
	def has_key(self, key):
		return(irc_lower(key) in self.canon_keys)
	
	def update(self, dict):
		for (k, v) in dict.items():
			self.data[k] = v
	
	def get(self, key, failobj=None):
		return(self.data.get(key, failobj))

class IRCChannel(object):
	"""A class for keeping information about an IRC channel.
	
	This class can be improved a lot."""
	
	def __init__(self, connection):
		self.connection = connection
		self.userdict = IRCDict()
		self.operdict = IRCDict()
		self.voiceddict = IRCDict()
		self.modes = {}
	
	@property
	def users(self):
		"""Returns an unsorted list of the channel's users."""
		
		return(list(self.userdict.values()))
	
	@property
	def opers(self):
		"""Returns an unsorted list of the channel's operators."""
		
		return(list(self.operdict.values()))
	
	@property
	def voiced(self):
		"""Returns an unsorted list of the persons that have voice
		mode set in the channel."""
		
		return(list(self.voiceddict.values()))
	
	def has_user(self, user):
		"""Checks whether the channel has a user."""
		
		return(str(user) in self.userdict)
	
	def is_oper(self, user):
		"""Checks whether a user has operator status in the channel."""
		
		return(str(user) in self.operdict)
	
	def is_voiced(self, user):
		"""Checks whether a user has voice mode set in the channel."""
		
		return(str(user) in self.voiceddict)
	
	def add_user(self, user):
		if isinstance(user, IRCUser):
			self.userdict[user.nick] = user
		elif user not in self.userdict:
			self.userdict[user] = IRCUser(user)
	
	def remove_user(self, user):
		nick = str(user)
		for d in self.userdict, self.operdict, self.voiceddict:
			if nick in d:
				del d[nick]
	
	def change_nick(self, before, after):
		if before not in self.userdict:
			return
		
		user = self.userdict[before]
		self.userdict[after] = user
		del self.userdict[before]
		if before in self.operdict:
			self.operdict[after] = user
			del self.operdict[before]
		if before in self.voiceddict:
			self.voiceddict[after] = user
			del self.voiceddict[before]
	
	def set_mode(self, mode, value=None):
		"""Sets a mode on the channel. Should only be passed strings."""
		
		# TODO: Support more modes
		if mode == "o":
			self.operdict[value] = IRCUser(self.connection, nick=value)
		elif mode == "v":
			self.voiceddict[value] = IRCUser(self.connection, nick=value)
		else:
			self.modes[mode] = value
	
	def clear_mode(self, mode, value=None):
		"""Removes a mode on the channel."""
		
		try:
			if mode == "o":
				del self.operdict[value]
			elif mode == "v":
				del self.voiceddict[value]
			else:
				del self.modes[mode]
		except KeyError:
			pass
	
	def has_mode(self, mode):
		return(mode in self.modes)
	
	def is_moderated(self):
		return(self.has_mode("m"))
	
	def is_secret(self):
		return(self.has_mode("s"))
	
	def is_protected(self):
		return(self.has_mode("p"))
	
	def has_topic_lock(self):
		return(self.has_mode("t"))
	
	def is_invite_only(self):
		return(self.has_mode("i"))
	
	def has_allow_external_messages(self):
		return(self.has_mode("n"))
	
	def has_limit(self):
		return(self.has_mode("l"))
	
	def limit(self):
		if self.has_limit():
			return(self.modes["l"])
		else:
			return(None)
	
	def has_key(self):
		return(self.has_mode("k"))
	
	def key(self):
		if self.has_key():
			return(self.modes["k"])
		else:
			return(None)

def IRCUser(object):
	def __init__(self, connection, mask=None, nick=None, user=None, host=None):
		if not(mask or nick):
			raise(IRCError("Needs at least one of mask or nick."))
		
		self.connection = connection
		self._mask = mask
		self._nick = nick
		self._user = user
		self._host = host
		self._userhost = None
		self.update_values()
	
	def update_values(self):
		if self._mask:
			self._nick = self._mask.split("!")[0]
			self._userhost = self._mask.split("!")[1]
		
		if self._userhost:
			self._user = self._userhost.split("@")[0]
			self._host = self._userhost.split("@")[1]
	
	@property
	def mask(self):
		return(self._mask)
	
	@property
	def nick(self):
		return(self._nick)
	
	@property
	def user(self):
		return(self._user)
	
	@property
	def host(self):
		return(self._host)
	
	@property
	def userhost(self):
		return(self._userhost)
	
	def whois(self):
		self.connection.whois([self.nick])
	
	def __str__(self):
		return(self._nick)

## Properties ##

_LOW_LEVEL_QUOTE = "\020"
_CTCP_LEVEL_QUOTE = "\134"
_CTCP_DELIMITER = "\001"

_low_level_mapping = {
	"0": "\000",
	"n": "\n",
	"r": "\r",
	_LOW_LEVEL_QUOTE: _LOW_LEVEL_QUOTE
}

_low_level_regexp = re.compile(_LOW_LEVEL_QUOTE + "(.)")

def mask_matches(nick, mask):
	"""Checks if a nick matches a mask.
	
	Returns true if the nick matches, otherwise false."""
	
	nick = irc_lower(nick)
	mask = irc_lower(mask)
	mask = mask.replace("\\", "\\\\")
	for ch in ".$|[](){}+":
		mask = mask.replace(ch, "\\" + ch)
	mask = mask.replace("?", ".")
	mask = mask.replace("*", ".*")
	r = re.compile(mask, re.IGNORECASE)
	return(r.match(nick))

_special = "-[]\\`^{}"
nick_characters = string.ascii_letters + string.digits + _special

_ircstring_uc = string.ascii_uppercase + "[]\\^"
_ircstring_lc = string.ascii_lowercase + "{}|~"
try:
	_ircstring_translation = bytes.maketrans(str.encode(_ircstring_uc, "ascii"), str.encode(_ircstring_lc, "ascii"))
except AttributeError:
	_ircstring_translation = string.maketrans(_ircstring_uc, _ircstring_lc)

def irc_lower(s):
	"""Returns a lowercased string.
	
	The definition of lowercased comes from the IRC specification (RFC 1459)."""
	
	return(str(s).translate(_ircstring_translation))

def _ctcp_dequote(message):
	"""Dequotes a message according to CTCP specifications.
	
	The function returns a list where each element can be either a
	string (normal message) or a tuple of one or two strings (tagged
	messages).  If a tuple has only one element (ie is a singleton),
	that element is the tag; otherwise the tuple has two elements: the
	tag and the data."""
	
	def _low_level_replace(match_obj):
		ch = match_obj.group(1)
		
		# If low_level_mapping doesn't have the character as key, we
		# should just return the character.
		return(_low_level_mapping.get(ch, ch))
	
	if _LOW_LEVEL_QUOTE in message:
		# Yup, there was a quote.  Release the dequoter, man!
		message = _low_level_regexp.sub(_low_level_replace, message)
	
	if _CTCP_DELIMITER not in message:
		return([message])
	else:
		# Split it into parts.  (Does any IRC client actually *use*
		# CTCP stacking like this?)
		chunks = message.split(_CTCP_DELIMITER)
		
		messages = []
		i = 0
		while i < len(chunks)-1:
			# Add message if it's non-empty.
			if len(chunks[i]) > 0:
				messages.append(chunks[i])
			
			if i < len(chunks)-2:
				# Aye!  CTCP tagged data ahead!
				messages.append(tuple(chunks[i+1].split(" ", 1)))
			
			i = i + 2
		
		if len(chunks) % 2 == 0:
			# Hey, a lonely _CTCP_DELIMITER at the end!  This means
			# that the last chunk, including the delimiter, is a
			# normal message!  (This is according to the CTCP
			# specification.)
			messages.append(_CTCP_DELIMITER + chunks[-1])
		
		return(messages)

def is_channel(channel):
	"""Checks if a string is a channel name.
	
	Returns true if the argument is a channel name, otherwise false."""
	
	if isinstance(channel, IRCChannel):
		return(True)
	else:
		return(len(channel) > 1 and channel[0] in "#&+!")

def ip_numstr_to_quad(num):
	"""Converts an IP number as an integer given in ASCII representation
	(e.g. '3232235521') to an IP address string (e.g. '192.168.0.1')."""
	
	n = long(num)
	p = map(str, map(int, [n >> 24 & 0xFF, n >> 16 & 0xFF, n >> 8 & 0xFF, n & 0xFF]))
	return(".".join(p))

def ip_quad_to_numstr(quad):
	"""Converts an IP address string (e.g. '192.168.0.1') to an IP number as an
	integer given in ASCII representation (e.g. '3232235521')."""
	
	p = map(long, quad.split("."))
	s = str((p[0] << 24) | (p[1] << 16) | (p[2] << 8) | p[3])
	if s[-1] == "L":
		s = s[:-1]
	return(s)

def nm_to_n(s):
	"""Gets the nick part of a nickmask.
	
	(The source of an Event is a nickmask.)"""
	
	if isinstance(s, IRCUser):
		return(s.nick)
	else:
		return(s.split("!")[0])

def nm_to_uh(s):
	"""Gets the userhost part of a nickmask.
	
	(The source of an Event is a nickmask.)"""
	
	if isinstance(s, IRCUser):
		return(s.userhost)
	else:
		return(s.split("!")[1])

def nm_to_h(s):
	"""Gets the host part of a nickmask.
	
	(The source of an Event is a nickmask.)"""
	
	if isinstance(s, IRCUser):
		return(s.host)
	else:
		return(s.split("@")[1])

def nm_to_u(s):
	"""Gets the user part of a nickmask.
	
	(The source of an Event is a nickmask.)"""
	
	if isinstance(s, IRCUser):
		return(s.user)
	else:
		s = s.split("!")[1]
		return(s.split("@")[0])

def parse_nick_modes(mode_string):
	"""Parses a nick mode string.
	
	The function returns a list of lists with three members: sign, mode and
	argument. The sign is '+' or '-'. The argument is always None.
	
	Example:
	
	>>> irclib.parse_nick_modes(\"+ab-c\")
	[['+', 'a', None], ['+', 'b', None], ['-', 'c', None]]
	"""
	
	return(_parse_modes(mode_string, ""))

def parse_channel_modes(mode_string):
	"""Parse a channel mode string.
	
	The function returns a list of lists with three members: sign,
	mode and argument.  The sign is '+' or '-'.  The argument is
	None if mode isn't one of 'b', 'k', 'l', 'v' or 'o'.
	
	Example:
	
	>>> irclib.parse_channel_modes(\"+ab-c foo\")
	[['+', 'a', None], ['+', 'b', 'foo'], ['-', 'c', None]]
	"""
	
	return(_parse_modes(mode_string, "bklvo"))

def _parse_modes(mode_string, unary_modes=""):
	"""Parses a mode string."""
	
	modes = []
	arg_count = 0
	
	# State variable.
	sign = ""
	
	a = mode_string.split()
	if len(a) == 0:
		return([])
	else:
		mode_part, args = a[0], a[1:]
	
	if mode_part[0] not in "+-":
		return([])
	for ch in mode_part:
		if ch in "+-":
			sign = ch
		elif ch == " ":
			collecting_arguments = 1
		elif ch in unary_modes:
			if len(args) >= arg_count + 1:
				modes.append([sign, ch, args[arg_count]])
				arg_count = arg_count + 1
			else:
				modes.append([sign, ch, None])
		else:
			modes.append([sign, ch, None])
	return(modes)

def _ping_ponger(connection, event):
	"""Returns a PONG to the server after it sent a PING."""
	
	connection.pong(event.target())

# Numeric table mostly stolen from the Perl IRC module (Net::IRC).
numeric_events = {
	"001": "welcome",
	"002": "yourhost",
	"003": "created",
	"004": "myinfo",
	"005": "featurelist", # XXX
	"200": "tracelink",
	"201": "traceconnecting",
	"202": "tracehandshake",
	"203": "traceunknown",
	"204": "traceoperator",
	"205": "traceuser",
	"206": "traceserver",
	"207": "traceservice",
	"208": "tracenewtype",
	"209": "traceclass",
	"210": "tracereconnect",
	"211": "statslinkinfo",
	"212": "statscommands",
	"213": "statscline",
	"214": "statsnline",
	"215": "statsiline",
	"216": "statskline",
	"217": "statsqline",
	"218": "statsyline",
	"219": "endofstats",
	"221": "umodeis",
	"231": "serviceinfo",
	"232": "endofservices",
	"233": "service",
	"234": "servlist",
	"235": "servlistend",
	"241": "statslline",
	"242": "statsuptime",
	"243": "statsoline",
	"244": "statshline",
	"250": "luserconns",
	"251": "luserclient",
	"252": "luserop",
	"253": "luserunknown",
	"254": "luserchannels",
	"255": "luserme",
	"256": "adminme",
	"257": "adminloc1",
	"258": "adminloc2",
	"259": "adminemail",
	"261": "tracelog",
	"262": "endoftrace",
	"263": "tryagain",
	"265": "n_local",
	"266": "n_global",
	"300": "none",
	"301": "away",
	"302": "userhost",
	"303": "ison",
	"305": "unaway",
	"306": "nowaway",
	"311": "whoisuser",
	"312": "whoisserver",
	"313": "whoisoperator",
	"314": "whowasuser",
	"315": "endofwho",
	"316": "whoischanop",
	"317": "whoisidle",
	"318": "endofwhois",
	"319": "whoischannels",
	"321": "liststart",
	"322": "list",
	"323": "listend",
	"324": "channelmodeis",
	"329": "channelcreate",
	"331": "notopic",
	"332": "currenttopic",
	"333": "topicinfo",
	"341": "inviting",
	"342": "summoning",
	"346": "invitelist",
	"347": "endofinvitelist",
	"348": "exceptlist",
	"349": "endofexceptlist",
	"351": "version",
	"352": "whoreply",
	"353": "namreply",
	"361": "killdone",
	"362": "closing",
	"363": "closeend",
	"364": "links",
	"365": "endoflinks",
	"366": "endofnames",
	"367": "banlist",
	"368": "endofbanlist",
	"369": "endofwhowas",
	"371": "info",
	"372": "motd",
	"373": "infostart",
	"374": "endofinfo",
	"375": "motdstart",
	"376": "endofmotd",
	"377": "motd2",	# 1997-10-16 -- tkil
	"381": "youreoper",
	"382": "rehashing",
	"384": "myportis",
	"391": "time",
	"392": "usersstart",
	"393": "users",
	"394": "endofusers",
	"395": "nousers",
	"401": "nosuchnick",
	"402": "nosuchserver",
	"403": "nosuchchannel",
	"404": "cannotsendtochan",
	"405": "toomanychannels",
	"406": "wasnosuchnick",
	"407": "toomanytargets",
	"409": "noorigin",
	"411": "norecipient",
	"412": "notexttosend",
	"413": "notoplevel",
	"414": "wildtoplevel",
	"421": "unknowncommand",
	"422": "nomotd",
	"423": "noadmininfo",
	"424": "fileerror",
	"431": "nonicknamegiven",
	"432": "erroneusnickname", # [sic]
	"433": "nicknameinuse",
	"436": "nickcollision",
	"437": "unavailresource", # "Nick temporally unavailable"
	"441": "usernotinchannel",
	"442": "notonchannel",
	"443": "useronchannel",
	"444": "nologin",
	"445": "summondisabled",
	"446": "usersdisabled",
	"451": "notregistered",
	"461": "needmoreparams",
	"462": "alreadyregistered",
	"463": "nopermforhost",
	"464": "passwdmismatch",
	"465": "yourebannedcreep", # I love this one...
	"466": "youwillbebanned",
	"467": "keyset",
	"471": "channelisfull",
	"472": "unknownmode",
	"473": "inviteonlychan",
	"474": "bannedfromchan",
	"475": "badchannelkey",
	"476": "badchanmask",
	"477": "nochanmodes", # "Channel doesn't support modes"
	"478": "banlistfull",
	"481": "noprivileges",
	"482": "chanoprivsneeded",
	"483": "cantkillserver",
	"484": "restricted", # Connection is restricted
	"485": "uniqopprivsneeded",
	"491": "nooperhost",
	"492": "noservicehost",
	"501": "umodeunknownflag",
	"502": "usersdontmatch",
}

generated_events = [
	# Generated events
	"dcc_connect",
	"dcc_disconnect",
	"dccmsg",
	"disconnect",
	"ctcp",
	"ctcpreply",
]

protocol_events = [
	# IRC protocol events
	"error",
	"join",
	"kick",
	"mode",
	"part",
	"ping",
	"privmsg",
	"privnotice",
	"pubmsg",
	"pubnotice",
	"quit",
	"invite",
	"pong",
]

all_events = generated_events + protocol_events + list(numeric_events.values())
